home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / VkWebViewerBase.z / VkWebViewerBase
Encoding:
Text File  |  2002-10-03  |  12.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))                                          VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkWebViewerBase - Web viewing component
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent, wvBrowser : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkWebViewer.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkWebViewerBase(const char *, VkComponent)
  20.            VkWebViewerBase(const char *, Widget)
  21.            VkWebViewerBase(const char *)
  22.            ~VkWebViewerBase();
  23.  
  24.  
  25.    AAAAcccccccceeeessssssssiiiinnnngggg UUUURRRRLLLLssss aaaannnndddd FFFFiiiilllleeeessss
  26.            void fetchUrl(const cstring& url, const cstring& query,
  27.                       const cstring& method, NavigationFlags nav);
  28.            void fetchFile(const cstring& filename, NavigationFlags nav);
  29.  
  30.  
  31.    LLLLooooaaaaddddiiiinnnngggg ccccoooonnnnttttrrrroooollll
  32.            void stopFetch()
  33.  
  34.  
  35.    MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss
  36.            void setFollowLinks(Boolean f)
  37.            Boolean getFollowLinks()
  38.            void notify(NotifyReason, const char* message);
  39.            void postError(const char*)
  40.  
  41.  
  42.  
  43. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  44.      This viewkit component provides a means for application which would like
  45.      to provide web access from within the application. Many reasons for
  46.      providing such access may have little to do with the web "per se."  For
  47.      example, this component can be used with a form and the post method to
  48.      obtain a license for a user from a local or remote server. The component
  49.      can be used to format text and images in a purely read-only fashion, or
  50.      could be used to provide help to the user. See also VkWebViewer.
  51.  
  52.      This component complies with the HTML level 3.2 specification. Tables are
  53.      supported fully (excepting decimal alignment),  and some Netscape
  54.      extensions are supported,  including FRAMES and partial support for the
  55.      CENTER tag and various attributes such as background images and colors
  56.      for text.
  57.  
  58.      The 2.0 version added support for tables, frames and the semantics for
  59.      IMG and TABLE where LEFT and RIGHT alignments flow the remaining text
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))                                          VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))
  71.  
  72.  
  73.  
  74.      around. Additions in the 3.0 version include CSS1 stylesheets,
  75.      JavaScript, plugins (o32 only), animated gifs, authentication, cookies,
  76.      and additional small bits of tags and attributes.
  77.  
  78.      In this version,  the superclass of the ViewKit components is wvBrowser,
  79.      and many methods have been moved upward into the wvBrowser superclass.
  80.      Note that it is somewhat more tricky to work with this since we're using
  81.      C++ multiple inheritence.  Note that the library version has been
  82.      incremented since the interface changes can not be made in a binary
  83.      compatible fashion.  Developers who've overriden methods in
  84.      VkWebViewerBase would be well advised to examine wvBrowser and override
  85.      the equivalent methods there.  Application programmers who've use the
  86.      ViewKit components unchanged should not have any issues after
  87.      recompilation.
  88.  
  89.      Methods which have new virtuals in wvBrowser which should be used for
  90.      proper override include.  One general tendency is to use the string class
  91.      defined in /usr/include/CC/mstring.h to pass parameters.  The moved
  92.      methods include:
  93.  
  94.  
  95.    aaaaccccttttiiiivvvvaaaatttteeee
  96.      Override the activate(const cstring& url, ...) method instead.
  97.  
  98.    ggggoooottttooooUUUUrrrrllll
  99.      fetchUrl is slightly more functional.
  100.  
  101.    llllooooaaaaddddFFFFiiiilllleeee
  102.      fetchFile
  103.  
  104.    ffffiiiinnnnddddWWWWiiiinnnnddddoooowwwwTTTTaaaarrrrggggeeeetttt
  105.      findTargetBrowser - You must override this instead.  findWindowTarget can
  106.      now only be used as a call interface.  Overriding it will not produce any
  107.      effect.
  108.  
  109.    nnnnoooottttiiiiffffyyyy
  110.      You should preferentially override the notify(NotifyReason, const char*)
  111.      version of this method. notify(const char*) is kept for source
  112.      compatibility.
  113.  
  114.    ssssttttooooppppTTTTrrrraaaannnnssssffffeeeerrrr
  115.      Call or override stopFetch instead.  You may continue to call
  116.      stopTransfer from an application.
  117.  
  118.  
  119.      There have been other semantic changes.  Caching interfaces are no longer
  120.      available as caching is in the websupport ism and cannot be
  121.      programmatically controlled. The user can control global caching behavior
  122.      with the controlpanel supplied.  Navigation is now supported for any
  123.      wvBrowser object,  although only VkWebViewer supplies a builtin GUI.  To
  124.      use navigation with VkWebViewerBase as a toplevel frame,  create a
  125.      wvNavigator object with the toplevel frame's browser as the argument.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))                                          VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))
  137.  
  138.  
  139.  
  140.      Other public include files now exist for the wvNavigator and wvBrowser
  141.      objects, and previous public objects are now in their own wvObjects.h
  142.      include file.
  143.  
  144.      Several methods in the public include file, dumpDocument and
  145.      dumpStructure are primarily included for our own debugging use,  but may
  146.      prove interesting to curious programmers who want to know how the data is
  147.      stored internally for the HTML documents and rendering structures.
  148.  
  149.  
  150.    WWWWeeeebbbb ssssiiiitttteeeessss
  151.      Web sites which may be of interest to the user of this component or the
  152.      VkWebViewer subclass:
  153.  
  154.  
  155.            Web consortium:
  156.               http://www.w3.org/
  157.            Web consortium style sheet information:
  158.               http://www.w3.org/Style
  159.            VRML information:
  160.               http://vrml.wired.com/vrml.tech/
  161.            HTML specs at the W3 consortium:
  162.               http://www.w3.org/hypertext/WWW/MarkUp/html-spec/html-spec.txt
  163.            Yahoo WWW HTML list:
  164.               http://www.yahoo.com/Computers/World_Wide_Web/HTML/
  165.            Style sheets for SGML:
  166.               http://www.falch.no/~pepper/DSSSL-Lite/
  167.            Word processor file filters for HTML:
  168.               http://www.w3.org/hypertext/WWW/Tools/Word_proc_filters.html
  169.            Netscape's HTML extensions:
  170.               http://home.netscape.com/assist/net_sites/html_extensions.html
  171.            SGML on the Web:
  172.               http://www.ncsa.uiuc.edu/SDG/Software/Mosaic/WebSGML.html
  173.  
  174.  
  175.  
  176. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  177.    vvvvooooiiiidddd ffffeeeettttcccchhhhUUUUrrrrllll((((ccccoooonnnnsssstttt ccccssssttttrrrriiiinnnngggg&&&& uuuurrrrllll,,,, ccccoooonnnnsssstttt ccccssssttttrrrriiiinnnngggg&&&& qqqquuuueeeerrrryyyy,,,,
  178.                  ccccoooonnnnsssstttt ccccssssttttrrrriiiinnnngggg&&&& mmmmeeeetttthhhhoooodddd,,,, NNNNaaaavvvviiiiggggaaaattttiiiioooonnnnFFFFllllaaaaggggssss ==== NNNNAAAAVVVV____NNNNOOOONNNNEEEE))))
  179.      This is a wvBrowser method and should be used in place of gotoLink.  Main
  180.      method used to load a URL. The method is normally "GET". "POST" is
  181.      generally used for form queries. NavigationFlags advise the browser as to
  182.      whether this load is the result of navigation and will not normally be
  183.      used by a calling application.
  184.  
  185.  
  186.    vvvvooooiiiidddd ffffeeeettttcccchhhhFFFFiiiilllleeee((((ccccoooonnnnsssstttt ccccssssttttrrrriiiinnnngggg&&&& ffffiiiilllleeeennnnaaaammmmeeee,,,, NNNNaaaavvvviiiiggggaaaattttiiiioooonnnnFFFFllllaaaaggggssss ==== NNNNAAAAVVVV____NNNNOOOONNNNEEEE))))
  187.      This is a wvBrowser method and should be used in place of loadFile.  This
  188.      may be thought of as a functional equivalent of fetchUrl for the given
  189.      filename as a file: url.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))                                          VVVVkkkkWWWWeeeebbbbVVVViiiieeeewwwweeeerrrrBBBBaaaasssseeee((((3333))))
  203.  
  204.  
  205.  
  206.    vvvvooooiiiidddd ssssttttooooppppFFFFeeeettttcccchhhh(((())))
  207.      This is a wvBrowser method and should be used in place of stopTransfer.
  208.      Stops the current transfer in progress. This can be called at anytime,
  209.      even if there is no transfer in progress. This also sets flags to abort
  210.      the loading of any images or other associated files which are currently
  211.      in progress.  Note that this only will apply to loading associated with
  212.      the object this is called with.
  213.  
  214.  
  215.    vvvvooooiiiidddd sssseeeettttFFFFoooolllllllloooowwwwLLLLiiiinnnnkkkkssss((((BBBBoooooooolllleeeeaaaannnn ffffllllaaaagggg))))
  216.      If this is set to False (default in the base class,  True is the default
  217.      for VkWebViewer) then the user clicking on a link will not cause the
  218.      viewer to follow the link to show the new page.
  219.  
  220.  
  221.    BBBBoooooooolllleeeeaaaannnn ggggeeeettttFFFFoooolllllllloooowwwwLLLLiiiinnnnkkkkssss(((())))
  222.      Obtain the value of the flag for following links.
  223.  
  224.  
  225.    ttttiiiimmmmeeee____tttt ggggeeeettttDDDDeeeeffffaaaauuuullllttttEEEExxxxppppiiiirrrraaaattttiiiioooonnnn(((())))
  226.      Returns the value of the defaultExpiration.
  227.  
  228.  
  229.    vvvvooooiiiidddd ppppoooossssttttEEEErrrrrrrroooorrrr((((ccccoooonnnnsssstttt cccchhhhaaaarrrr**** mmmmeeeessssssssaaaaggggeeee))))
  230.      Posts message in an error dialog as a convenience to the programmer.
  231.  
  232.  
  233. BBBBuuuuggggssss aaaannnndddd LLLLiiiimmmmiiiittttaaaattttiiiioooonnnnssss
  234.      Although the viewer loads the page and images asynchronously,  the user
  235.      interface must still become unavailable during the initial network lookup
  236.      of the web site being accessed.  This is,  at the moment,  unavoidable
  237.      and a problem for all browsers.
  238.  
  239.      Although FTP sites can be accessed,  only viewable items should be
  240.      followed by the user.  Other items,  such as binary files,  will be
  241.      downloaded,  but there is no mechanism for saving them.
  242.  
  243.      This man page does not truly supply sufficient information for
  244.      subclassers.
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.